chore: Define precedence for deprecated 'auth_tokens' vs. 'auth_headers' #237
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anubhav756
force-pushed
the
anubhav-default-toolset
branch
from
3a066a9 to
da9431c
Compare
anubhav756
force-pushed
the
anubhav-reverse-deprecation
branch
from
204a6f5 to
64f214c
Compare
kurtisvg
approved these changes
May 12, 2025
anubhav756
force-pushed
the
anubhav-default-toolset
branch
from
da9431c to
03ad571
Compare
anubhav756
force-pushed
the
anubhav-reverse-deprecation
branch
2 times, most recently
from
047b827 to
e7178f9
Compare
anubhav756
force-pushed
the
anubhav-default-toolset
branch
2 times, most recently
from
9dd24ce to
d1c6879
Compare
anubhav756
force-pushed
the
anubhav-reverse-deprecation
branch
from
e7178f9 to
75e7fd2
Compare
anubhav756
force-pushed
the
anubhav-default-toolset
branch
from
d1c6879 to
8271660
Compare
anubhav756
force-pushed
the
anubhav-reverse-deprecation
branch
from
75e7fd2 to
aa3b15c
Compare
anubhav756
force-pushed
the
anubhav-default-toolset
branch
from
8271660 to
506c369
Compare
anubhav756
force-pushed
the
anubhav-reverse-deprecation
branch
from
aa3b15c to
fc79de2
Compare
This PR addresses the scenario where a user provides both `auth_tokens` and `auth_headers`, both of which are deprecated arguments. ### Problem Previously, if a user provided both `auth_tokens` and `auth_headers`, the authentication tokens from `auth_headers` were prioritized. This created an inconsistent behavior, especially considering that `auth_tokens` was deprecated more recently than `auth_headers`. ### Solution This change shifts the precedence to `auth_tokens`. Now, if both `auth_tokens` and `auth_headers` are present, only the authentication tokens specified in `auth_tokens` will be considered. ### Reasoning 1. `auth_tokens` was deprecated more recently than `auth_headers`. Prioritizing the more recently deprecated argument provides a clearer signal to users about the intended deprecation path and guides them towards the recommended, non-deprecated args. 2. We opted *not* to merge authentication tokens from both deprecated arguments. Merging could lead to increased user confusion and inadvertently encourage continued reliance on these legacy features, hindering migration efforts. 3. This approach aligns with our broader deprecation strategy. For instance, when a user provides `auth_token_getters` (the current recommended approach) alongside a deprecated argument like `auth_tokens`, `auth_token_getters` takes precedence and overrides the deprecated argument. This PR extends that "latest argument wins" principle to the deprecated arguments themselves, ensuring consistent behavior.
anubhav756
force-pushed
the
anubhav-reverse-deprecation
branch
from
fc79de2 to
881111e
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the scenario where a user provides both
auth_tokensandauth_headers, both of which are deprecated arguments.Problem
Previously, if a user provided both
auth_tokensandauth_headers, the authentication tokens fromauth_headerswere prioritized. This created an inconsistent behavior, especially considering thatauth_tokenswas deprecated more recently thanauth_headers.Solution
This change shifts the precedence to
auth_tokens. Now, if bothauth_tokensandauth_headersare present, only the authentication tokens specified inauth_tokenswill be considered.Reasoning
auth_tokenswas deprecated more recently thanauth_headers. Prioritizing the more recently deprecated argument provides a clearer signal to users about the intended deprecation path and guides them towards the recommended, non-deprecated args.auth_token_getters(the current recommended approach) alongside a deprecated argument likeauth_tokens,auth_token_getterstakes precedence and overrides the deprecated argument. This PR extends that "latest argument wins" principle to the deprecated arguments themselves, ensuring consistent behavior.